home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 029a / pcindx.zip / HELP.001 < prev    next >
Text File  |  1991-08-20  |  14KB  |  272 lines

  1.  
  2.                  INDEX TYPE ONE:  SINGLE WORD INDEX
  3.  
  4.   There are two single word indexes available with PC─INDEX.  The
  5.   first is capable of producing an index on every single word in a
  6.   document.  The second index type will only index capitalized
  7.   words.  
  8.  
  9.   Controls are available which allow you to either include only the
  10.   words you want or to automatically discard common words like
  11.   'a','and', 'the', etc.
  12.  
  13.   To begin using PC─INDEX type PCI and press enter.
  14.  
  15.  
  16.                   STEP ONE:  Extract Single Words
  17.  
  18.   This option will extract words from a document, one at a time,
  19.   and record them in sorted order along with the page number that
  20.   they occur on.  Many words like a, and, the, if, of, etc will be
  21.   eliminated and will not be recorded unless you change the
  22.   options.
  23.  
  24.   First, select Text (ASCII) as the document type from the Document
  25.   menu.  If the wrong document type is selected, results will be
  26.   unpredictable.
  27.  
  28.   Next, select the Extract Single Words option from the FILE menu,
  29.   by using the cursor keys and pressing ENTER.  You should now see
  30.   a new window asking you for an input filename, an output
  31.   filename, the page size, the first page number to start indexing
  32.   on, the first page number to use, and several other options.
  33.  
  34.   For the input filename type 'PCI.DOC' and press enter.  The
  35.   output filename 'PCI.SRT' will be entered automatically.  You can
  36.   also press F2 here to display a list of files and select a file
  37.   from the list.  
  38.  
  39.   This document was created using 60 lines per page (the standard
  40.   for letter size paper is usually 66, but to accommodate those
  41.   with laser  printers we used 60 here).  Leave this setting as it
  42.   is.  
  43.  
  44.   Next enter 4 for the Start Indexing on Page entry, (we want to
  45.   skip the first 3 pages that contain the title page, the
  46.   disclaimer, and the table of contents) and begin indexing with
  47.   the 4th page.  Leave the First Page Number to use setting at 1. 
  48.   This will make PC─INDEX skip the first 3 pages, begin indexing on
  49.   page 5, but use page number one for the first page indexed.
  50.  
  51.   The rest of the selections can be broken into two types.  Which
  52.   word list to use and what type of conversion to perform.  One
  53.   selection can be made from the choices in each of the two groups.
  54.  
  55.   The three choices on the left determine what words will be
  56.   included in the index.  If you select the first choice, Don't Use
  57.   Any Word List, all words in the document will be included in the
  58.   index.  If you select the second choice, Use Include Word List,
  59.   only the words found in the include word list will be indexed. 
  60.   If you select the third choice, Use Discard Word List, all common
  61.   words in the Discard Word List will automatically be eliminated
  62.   from the index, all other words will be included. 
  63.  
  64.   The four choices on the right determine what type of case
  65.   conversion will be performed on each word, if any.  If you select
  66.   the first option, Perform No Conversion on Word, then all words
  67.   will be left alone and no conversion will be performed.  By
  68.   selecting Convert Word to UPPER Case or Convert Word to lower
  69.   case, all words can be converted to all upper or all lower case. 
  70.   If you select Convert Word to UPPER/lower Case, the first letter
  71.   of each word will be converted to uppercase and the rest of the
  72.   word will be lower case.
  73.  
  74.   The completed window should look like this:
  75.                                                                  
  76.   ┌───────────────────────────────────────────────────────────────┐
  77.   │  Input File Name:   (Name of Document to process)             │
  78.   │  pci.doc                                                      │
  79.   │                                                               │
  80.   │  Output File Name:                                            │
  81.   │  pci.srt                                                      │
  82.   │                                                               │
  83.   │  Page Size  Start Indexing on Page   First Page Number to use │
  84.   │    60               4                            1            │
  85.   │                                                               │
  86.   │    Don't Use Any Word List   X   Perform No Conversion on Word│
  87.   │                                                               │
  88.   │    Use Include Word List         Convert Word to UPPER Case   │
  89.   │                                                               │
  90.   │  X Use Discard Word List         Convert Word to lower Case   │
  91.   │                                                               │
  92.   │                                  Convert Word to UPPER/lower  │
  93.   └───────────────────────────────────────────────────────────────┘
  94.  
  95.   When you have finished entering the filenames and other
  96.   information, press F10 to begin processing 'PCI.DOC'.
  97.  
  98.   You should now see a window which gives you the current status
  99.   and tells you how the processing of PCI.DOC is going.  You will
  100.   be kept informed of how many characters, lines, words, and pages
  101.   have been processed as well as how many matches have been found. 
  102.  
  103.  
  104.  
  105.  
  106.                  STEP TWO:  Edit Extracted word file
  107.  
  108.   This step is optional, although you will probably want to use it.
  109.  
  110.   It gives you a chance to fine tune the single word index before
  111.   you complete it.  By using this option, you can deactivate words
  112.   so that they will not be included in the index and change the
  113.   case of words that are included from lowercase to uppercase and
  114.   vice versa. 
  115.  
  116.   Select the 'Edit Extracted word file' option from the EDIT menu. 
  117.   You will be asked for an input filename.  PC─INDEX will enter the
  118.   name of the output file from the Extract Words option, PCI.SRT. 
  119.   Just leave the name alone and press enter.  After a few seconds
  120.   you will see a list of each unique word in PCI.DOC.              
  121.                                                            
  122.   ┌──────────────────────────────────────────────────────────────┐
  123.   │                     ┌────────────────┐                       │
  124.   │                     │ * additional   │                       │
  125.   │                     │ * abort        │                       │
  126.   │                     │ * absence      │                       │
  127.   │                     │ * acceptance   │                       │
  128.   │                     │ * accordingly  │                       │
  129.   │                     │ * accurate     │                       │
  130.   │                     │ * accurately   │                       │
  131.   │                     │ * active       │                       │
  132.   │                     │ * actual       │                       │
  133.   │                     │ * adapter      │                       │
  134.   │                     │ * add          │                       │
  135.   │                     │ * added        │                       │
  136.   │                     │ * addition     │                       │
  137.   │                     │ * additional   │                       │
  138.   │                     │ * address      │                       │
  139.   │                     │ * adhering     │                       │
  140.   │                     │ * adjust       │                       │
  141.   │                     │ * advanced     │                       │
  142.   │                     │ * advertising  │                       │
  143.   │                     │ * afford       │                       │
  144.   │                     │ * AGREEMENT    │                       │
  145.   │                     └────────────────┘                       │
  146.   │ESC─end SPACE─mark/clear one entry F2─mark/clear all F3─UPPER │
  147.   │          F4─lower case F5─UPPER lower F6─top  F7─next        │
  148.   └──────────────────────────────────────────────────────────────┘
  149.  
  150.   To the far left of each word is an asterisk.  The presence or
  151.   absence of an asterisk indicates whether or not the word is
  152.   active.  If a word is active, it will be included in the index
  153.   when it is created.  Words can be toggled one at a time between
  154.   being active and inactive by using the spacebar.  The 
  155.   words can also be toggled as a group between being active and
  156.   inactive by pressing F2.  By pressing F2 all words will be
  157.   alternately set to active or inactive.
  158.  
  159.   If you have individual words which need to be different you may
  160.   change them here.  For instance go to the entry 'ASCII'.  Since
  161.   ASCII is an abbreviation it needs to be listed in uppercase.  By
  162.   pressing F3, the entry will be changed immediately to all
  163.   uppercase if it isn't already.  You may have a name which needs
  164.   to have the first letter uppercase and the rest lowercase.  For
  165.   example go to the entry 'Australia'.  By pressing F5 you can
  166.   change the word from australia to Australia.  In the same manner,
  167.   pressing F4 would change the word to all lower case.
  168.  
  169.   If you are processing a large document, you may have more words
  170.   than the Edit Extracted Word File option will allow you to work
  171.   with at one time.  Edit Extracted Word File allows up to 1000
  172.   unique words to be in memory at any one time.  If your list
  173.   contains more than 1000 words, you can get the next group of
  174.   words by pressing F7.  You can continue this process until you
  175.   have worked with the entire list.  You can go back to the first
  176.   group  (the top of the list) by pressing F6.
  177.  
  178.   When you are done editing the word list press ESCape to return to
  179.   the main menu.  All changes have already been saved.
  180.  
  181.  
  182.                STEP THREE:  Build Single Word Index
  183.  
  184.   The third and final step 'Build Single Word Index' is found under
  185.   the FILE menu.  This step takes the file created by the 'Extract
  186.   Single Words' selection and edited by the 'Edit Extracted Word
  187.   File' selection and creates the index.
  188.  
  189.   Select 'Build Single Word Index' from the FILE menu.  You will be
  190.   asked for the input file and output file.  PC─INDEX remembers the
  191.   name that you gave the file ('PCI.SRT') when you extracted the
  192.   word list.  You should leave this name as it is.
  193.  
  194.   Next you will be asked what name you want to use for the output
  195.   file.  This is the name that the actual index will be called. 
  196.   For this example we'll call it 'PCI.NDX'.
  197.  
  198.   The next entry is the Wildcard Description File Name.  This entry
  199.   is only used if you are processing several files at the same time.
  200.   We won't use it here.
  201.  
  202.   Next, PC─INDEX wants to know the page length (how many lines per
  203.   page) you want to use.  The default setting is 66 which is the
  204.   proper setting for letter size paper.  If you are using legal
  205.   size paper, the proper setting would be 88.  This number does not
  206.   need to match the lines per page setting you used when you
  207.   selected 'Extract Words'.  Many laser printers normally output 60
  208.   lines per page.  If you will be printing the index to a laser
  209.   printer you will want to set this option to 60.
  210.  
  211.   The next item to fill in is the page width.  Here you will enter
  212.   the total number of characters that will fit on one line or your
  213.   printer.  The maximum width accepted by PC─INDEX is 132
  214.   characters.  The number next to page width in reverse video is
  215.   the calculated width required for the settings you have selected.
  216.    
  217.   Next, PC─INDEX asks you the number of columns you would like the
  218.   index to be.  You will be able to produce an index up to four
  219.   columns wide.  An example of a two column index is included at
  220.   the end of this document.
  221.  
  222.   The column width is the next entry.  This entry controls the
  223.   width of each column in the index.  The minimum allowable width
  224.   is 30 characters and the maximum is 99.
  225.  
  226.   The number of spaces between columns can range from 1 to 9
  227.   characters.
  228.  
  229.   Next fill in the top, bottom, left, and right margins to the
  230.   settings that you wish.
  231.  
  232.   The completed input window should look something like this:
  233.  
  234.   ┌───────────────────────────────────────────────────────────────┐
  235.   │ Input File Name:                                              │
  236.   │ pci.srt                                                       │
  237.   │                                                               │
  238.   │ Output File Name:                                             │
  239.   │ pci.ndx                                                       │ 
  240.   │                                                               │
  241.   │ Wildcard Description File: (Leave blank if not needed)        │ 
  242.   │                                                               │
  243.   │ Page Size    Page Width  (Columns)      Number of Columns     │ 
  244.   │     66           80         78                  2             │
  245.   │ Column Width   Space Between Columns        Top Margin        │
  246.   │     30                 3                        5             │
  247.   │ Bottom Margin     Left Margin              Right Margin       │ 
  248.   │      5                 10                       5             │
  249.   │                                                               │
  250.   └───────────────────────────────────────────────────────────────┘
  251.  
  252.   When you have finished entering the filenames and other
  253.   information, press F10 to begin building the single word index.
  254.  
  255.   You should see a status box which tells you the number of words
  256.   to be processed, the number of words actually processed, the
  257.   letter of the alphabet currently being processed, percentage
  258.   completed, and the elapsed time.
  259.  
  260.   This process should only take a few seconds for this example. 
  261.   When it is finished, you will be returned to the main menu and
  262.   the completed index is contained in the text file named
  263.   'PCI.NDX'.  If you wish to view the file you can select View
  264.   Index from the File Menu.  If you want to print the index to a
  265.   printer select Print Index from the File Menu.  Since 'PCI.NDX'
  266.   is an ASCII file, you could also load it into almost any word
  267.   processor and edit it further if you wish. 
  268.  
  269.  
  270.  
  271.  
  272.